Report Designer
Employees will generate several documents, or Print Outs, while performing daily transactions in a system such as DEACOM. Examples of these transactions include producing goods, shipping finished products to customers, or purchasing raw materials from vendors. The documents generated as a result of these transactions might include a Job label indicating how much was produced, when it was produced, and any relevant Job-specific or item-specific data. Labels such as these will often be attached to the drum, pallet, or appropriate container used to store the goods in inventory. Another document example might be a Certificate of Analysis that is printed from an Inventory "Lots" report and indicates the Quality Control Tests and results for the selected Lot. When printing labels, users have the ability to enter print quantity, order qty, and other miscellaneous label information in the "labeluser1-3" fields from the Print Part Forms form. In DEACOM, the templates used to create these documents throughout the system are called Part Forms. Each Part Form is designed using Microsoft Word to allow for easy modification and design based on individual customer needs.
Additionally, DEACOM comes with a standard group of reports that handle essential print outs such as Vendor invoices, Sales Order confirmations, Job pick lists, bills of lading, and several others. Customers may use these default reports as delivered when processing transactions and print outs in the system or they can be replaced with configurable reports that allow organizations to meet their reporting and document needs. New reports cannot be added but existing reports can be modified.
The "Client Rendering" flag in the Report Designer is checked by checked by default. This flag helps in situations where users are experiencing delays in printing documents. If checked, this flag allows rendering on the device/client side as opposed to the server side. In this case, DEACOM will check the device/client side when verifying Active X Controls and appropriate drivers.
Pro tips regarding using the Report Designer include:
- Modify a report in a test system, and once it is printing as desired, export the file. Then in the production environment, import the file - smooth transition.
- Frequent exported backups are suggested on Report Layouts and Part Forms that are edited frequently.
- Add the date of export to the name of the file to keep track of which version it is. Keep in mind that the upload file name is not retained after upload.
The below tips may be used for overlapping object selection:
- Successive clicks on overlapping objects will cycle through them.
- Ctrl+ clicks on overlapping objects will select/deselect all.
- Selected objects can be dragged even if they are obscured by objects in front of them.
- Double clicking on a selected object will bring up its edit form even if it is obscured by objects in front of it.
Note: the ability to print up subscript and superscript is enabled by using the following expressions:
- Subscript - [sub]text[/sub]
- Superscript - [sup]text[/sup]
In addition, Report Variables on Report Layouts and Part Forms have been enhanced to allow users to specify values prior to printing documents. If this feature is utilized, then the Report Parameters form will be displayed, allowing users to confirm default values, or if necessary enter new ones. Users can also specify if parameter entries are required.
System Navigation
- Print Outs > Maintenance > Part Forms > "Modify" button > "Edit Doc" button
- Print Outs > Maintenance > Report Layouts > "Modify" button > "Edit Report" button
Report Designer form
Opened via the "Edit Doc" button on the Edit Part Form form or the "Edit Report" button on the Printing Defaults form, the Report Designer is used to customize the documents generated via various functions in the system. It contains a toolbar, toolbox, and one or more sections that divide up the actual page.
Toolbar
Button |
Description |
---|---|
Import Report |
File explorer used to select the document that will be used throughout the system. |
Export Report |
Exports a copy of the document as it is currently designed. |
Preview |
Opens a form to select a record or a transaction to use as an example to generate a preview of the open document.
|
Report Properties |
Opens the Edit Report form, which is used to:
Note: When the "Report Properties" button is clicked, if any changes to the report or part form have been made the user will be prompted to save changes first. |
Select All |
If clicked selects and outlines all report objects to allow them to be moved, cloned, modified etc. All objects will appear as blue when this button is clicked. |
Clone |
Duplicates the selected object(s). |
Modify |
Opens the Edit Field form, which is used to define the contents and specifications of objects. |
Delete |
Deletes the selected object(s). |
Bring to Front |
Moves the selected item to the front-most position. |
Bring Forwards |
Moves the selected item forward. |
Send Backwards |
Moves the selected item to the back-most position. |
Send to Back |
Moves the selected item backward. |
Align Left Sides |
Aligns items to the left side of the section. |
Align Right Sides |
Aligns items to the right side of the section. |
Align Top Sides |
Aligns items to the top of the section. |
Align Bottom Sides |
Aligns items to the bottom of the section. |
Align Vertical Centers |
Aligns items based on their vertical centers. |
Align Horizontal Centers |
Aligns items based on their horizontal centers. |
Edit Report form
Opened via the "Report Properties" button in the Report Designer Toolbar.
Layout tab
Used to set margins, print area, fonts, and printers.
Field/Flag |
Description |
---|---|
Name |
Displays the name of the document. |
Orientation |
Pick list used to dictate if the document is oriented Portrait or Landscape. |
Page Size |
Indicates the Page Size of the document when it is printed or viewed on screen. |
Top Margin/Bottom Margin/Left Margin/Right Margin |
Indicates the margin sizes of the document |
Detail Bands |
Indicates the number of detail bands that exist in the document. |
Page Header Band |
If checked, the report or part form will contain an editable page header. |
Page Footer Band |
If checked, the report or part form will contain an editable page header. |
Title Band |
If checked, the report or part form will contain an editable title band. The title band is a separate page. |
Summary Band |
If checked, the report or part form will contain an editable summary header. |
Summary Prints As New Page |
If checked, the report or part form will print the contents of the summary band as a separate page. |
Include Page Header With Summary |
If checked, the page header configured will be included in the summary. |
Include Page Footer With Summary |
If checked, the page footer configured will be included in the summary. |
Data Grouping tab
Defines how data will be grouped on the report. Only available when modifying Report Layouts.
Variables tab
Used to define or modify user-defined fields for calculations or to store information. A variable could be added that would sum whatever field was needed for the report. For example, if the report needed to sum the quantities for a field, a variable could be added that would sum "fi_quant". Report variables can be set and used in Print When statements. Variables work in the title, detail, and header bands. In addition, variables can be evaluated as strings and not just as numbers. Note: Report Variables on Report Layouts and Part Forms have been enhanced to allow users to specify values prior to printing documents. If this feature is utilized, then the Report Parameters form will be displayed prior to printing, allowing users to confirm default values, or if necessary enter new ones. Users can also specify if parameter entries are required.
Report Variables form
Opened via the "Add" or "Modify" button on the Edit Report Variables tab.
Field |
Description |
---|---|
Name |
Defines the name of the variable. Since the variable name will be used in Deacom equations, it should not include spaces. Underscores are often used instead of spaces. When used as parameters, the variable name will also be used to ask the user to enter information, so the variable name should be chosen keeping that in mind. Also, hashmarks "#" in variable names will cause invalid expressions and should be avoided. |
Parameter Type |
Defines the type of field for the selected variable. This allows greater flexibility in report/part form design and supports the use of different field masks. Options are:
Notes:
|
Expression |
Memo field used to store the variable's expression. Only available when selecting a Parameter Type of "None". |
Reset |
Pick list used to determine if the variable will reset on a Page or Report basis. Only available when selecting a Parameter Type of "None". |
Min Value |
Hold
|
Max Value |
Hold
|
Calculation Type |
Pick list used to select the type of calculation that will fire. Only available when selecting a Parameter Type of "None". Options are:
|
Initial Value |
Memo field used to store the initial value for the variable. Only available when selecting a Parameter Type of "Character", "Logical", "Numeric", and "Memo". |
Required |
Optional. If checked, users will be required to enter a value in this field prior to printing and the field will be marked in blue. Only available when selecting a Parameter Type other than "None". |
Order By tab
Used to sort the gathered report data in ascending or descending order for the specified field. Any field available to the report (checked via printing to variable display) may be used. Cannot use expressions, only fields.
Note: The items in this tab do not control the order of the fields on the report; that is controlled by the "Sort Expression" on the Printing Defaults form for the desired report.
Additional tabs in Classic
When operating in Classic versions of DEACOM, additional tabs are available to the Edit Report form. These include:
- Optional Bands - Used to define items pertaining to the title and summary bands, specifically printing options. Included in the Layout tab of web versions.
- Protection - If desired, used to set restrictions for users when modifying the report in protected mode.
- Ruler & Grid - Used to set units and spacing.
- Document Properties - Used to edit or add new properties and their corresponding expressions.
- Other - Used to edit Comments, User data, Tooltips, and Run-time extensions.
Edit Field form
Opened via the "Modify" button in the Report Designer Toolbar.
Field/Flag |
Description |
---|---|
Type |
Pick list used to determine if the object will contain a Caption, Expression, or Text. |
Block Type |
Pick list used to select the base tag or table tag that will be used to obtain the information for this record. Options are:
|
Encoding |
Pick list used to select if this field will contain a barcode, and if so what type (GS1-128, 3 of 9, Data Matrix, etc.). |
Barcode Height |
Indicates the height of the barcode.
|
Caption |
Search field used to select the Caption that should display in this field.
|
Expression |
Memo field used to store the expression or text that should display in this field.
|
Position |
Options are: Bottom, Float, and Top
|
Top/Left |
Indicates where on the document this field sits. |
Width/Height |
Indicates the width and height of this field. |
Rotation |
Indicates the angle at which this field should be rotated to display on the document. |
Format |
|
Alignment |
Pick list used to determine how this field is aligned. Options are:
|
Text Spacing |
Indicates the line spacing that will be applied between lines of text in the selected field. |
Font Name/Font Size |
Indicates the font name and size that will appear on the document, based on the selection in the "Encoding" field.
|
Foreground/Background |
Indicates the color that is used for the document area. |
Border Style |
Pick list used to determine if a border should exist for the object, and if so if it should be Dashed, Dotted, or Solid. |
Border Color |
Indicates the color that is used for the document border. |
Border Weight |
Indicates the thickness of the border. |
Print When |
Memo field used to store an expression of when this field should print on the document. |
Print Repeated Values |
If checked, repeated values for this field will print when the document is generated. |
Grow Vertically to Fit Contents |
If checked, the field size will expand vertically if contents extend beyond the designed area. |
Remove Line When Empty |
If checked, when this document is generated and there is no value in this field, it will not be included in the report. |
Print Text Right To Left |
If checked, when the report is printed, the text, expression, or caption will print in a right-to-left direction.
|
Limit Float to Objects Directly Above |
If checked, restricts rectangle, field, and line objects to only shift relative to the objects or fields directly above it instead of all objects/fields which could be affected by the current one, such as those below the object/field.
|
Use System Logo |
If checked, the system will insert the company logo, specified in the "Logo File Name" field in System > Options > Documents tab, into the selected rectangle on the report.
|
Toolbox
Classic
If this toolbar is not currently visible or is purposefully hidden, users can also navigate to Report > Insert Control on the main Report Designer toolbar to access the buttons discussed below. The following tabs are common to the Label, Field, and Picture buttons:
- General - Set caption, object position, size, and position.
- Style - Set font, color, and backstyle.
- Print When - Common to the Label, Field, and Picture buttons. Used to set Print repeated values, remove line if blank, and Print only logic.
- Protection - If desired, set restrictions for users when modifying the report in protected mode.
- Other - Used to edit Comments, User data, Tooltips, and Run-time extensions.
- Advanced - Used to edit and add advanced items and set Object Rotation, if necessary.
Button |
Table and Related Functions |
---|---|
Select Objects |
Pictured as a computer mouse, used to select an object on the report. |
Label |
If there is static data that needs to print on a report, a label object can be used. |
Field |
If there are fields that need to be printed on a report, the field object can be used. In addition to the tabs listed above, also includes:
|
Line |
Pictured as two perpendicular lines, used to insert a line on the report |
Rectangle |
Pictured as a rectangle, used to insert a rectangle on the report.
|
Rounded Rectangle |
Pictured as a rectangle with rounded edges, used to insert a rounded rectangle on the report.
|
Picture/OLE Bound Control |
Used to link and embed objects in the form. |
Web
As opposed to classic, in web the Report Controls are buttons on the left-hand side of the form, not in a separate toolbar. The available buttons include Rectangle, Field, Line, and Page Break. To select multiple objects at once, hold control + shift + click, then drag the mouse to highlight the objects on the report.
Sections
Part Forms have one area, detail, and Reports have five areas: title, header, detail, footer, and summary. Reports can have multiple header and footer sections based on data grouping. The number of data groupings the report will have and where the labels and fields are placed to return the data required will be determined by what the company needs the report to do. A basic overview of some of the fields and information used in the different sections is contained below.
- Title - Displays the company name and report title.
- Header - Used to store company or order-specific information such as company name, address, logo or trademark, order number, shipping terms, customer name and address, and order date.
- Detail - Generally used to store line item-specific data such as item numbers, description, quantities, and item locations.
- Footer - Used to store quantity and amount totals, outstanding balance information, page number counts, and additional notes such as contact information.
- Summary - Can be used to store additional information that would not normally be contained on the main print out, such as legal notices and terms and conditions.